HHH-17404 : Add support of reading/writing from/to special source/target in FormatMapper #9629

ejannett · 2025-01-16T14:14:10Z

This PR brings code changes needed by HHH-17404.
This adds the support of Oracle OSON (JSON binary format) to Hibernate allowing improved performance over
JSON to String conversions.

Two new types are defined
org.hibernate.dialect.OracleOsonJacksonJdbcType
and
org.hibernate.dialect.OracleOsonJacksonArrayJdbcType

The support of OSON is enabled by adding the Oracle JDBC extension jar as runtime dependency.
New capabilities in FormatMapper interface have been added to support the serialization and deserialization from different sources (OSON bytes, JSON String representation ,etc..).

The entire hibernate-core test suite has been successfully run with and without the enablement of OSON.
This has been done by adding/removing the Oracle JDBC extension in hibernate-testing project build file

runtimeOnly ('com.oracle.database.jdbc:ojdbc-provider-jackson-oson:1.0.4')
  {
            exclude group: 'com.oracle.database.jdbc', module: 'ojdbc8'
  }

The hibernate.dialect.oracle.oson_format_disabled new dialect settings has been also tested. With that
setting set to true in hibernate.properties file the extension is not used.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.

https://hibernate.atlassian.net/browse/HHH-17404
https://hibernate.atlassian.net/browse/HHH-14707

hibernate-github-bot · 2025-01-16T14:14:20Z

Thanks for your pull request!

This pull request appears to follow the contribution rules.

› This message was automatically generated.

hibernate-core/src/main/java/org/hibernate/dialect/JsonHelper.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonArrayJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonArrayJdbcType.java

hibernate-core/src/main/java/org/hibernate/type/format/ObjectArrayOsonDocumentWriter.java

hibernate-core/src/main/java/org/hibernate/type/format/jackson/JacksonOsonFormatMapper.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonArrayJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java

hibernate-core/src/main/java/org/hibernate/type/format/OsonDocumentReader.java

hibernate-core/src/main/java/org/hibernate/type/format/OsonDocumentWriter.java

hibernate-core/src/main/java/org/hibernate/dialect/JsonHelper.java

hibernate-core/src/main/java/org/hibernate/type/format/OsonDocumentWriter.java

hibernate-core/src/main/java/org/hibernate/type/format/OsonDocumentReader.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java

hibernate-core/src/main/java/org/hibernate/dialect/aggregate/OracleAggregateSupport.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonArrayJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/JsonHelper.java

hibernate-core/src/main/java/org/hibernate/type/format/StringJsonDocumentReader.java

hibernate-core/src/main/java/org/hibernate/dialect/aggregate/OracleAggregateSupport.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonArrayJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonJdbcType.java

hibernate-core/src/main/java/org/hibernate/type/format/StringJsonDocumentReader.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonJacksonArrayJdbcType.java

hibernate-core/src/test/java/org/hibernate/orm/test/mapping/hhh17404/JsonCBLOBToOsonTest.java

hibernate-core/src/main/java/org/hibernate/type/format/jackson/JacksonJsonFormatMapper.java

hibernate-core/src/main/java/org/hibernate/type/format/OsonValueJDBCTypeAdapter.java

hibernate-core/src/main/java/org/hibernate/type/format/StringJsonDocumentReader.java

mbellade

All major concerns should be addressed, CI is green except for oracle_atps that is failing for unrelated reasons. The PR look good to me, thanks @ejannett and @BidyadharM!

...-core/src/test/java/org/hibernate/orm/test/mapping/hhh17404/OracleOsonCompatibilityTest.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonArrayJdbcType.java

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java

yrodiere · 2025-06-05T10:05:36Z

Hey @ejannett @jeandelavarene , as discussed offline, there is now an AUTHORS.txt file. Could you please rebase, add Oracle to AUTHORS.txt, and remove any change to file headers (if any)?

We'll probably change/remove the headers at some point, but AFAIU this is not absolutely required for your contribution.

Thanks again for your work and your help.

hibernate-core/src/main/java/org/hibernate/type/format/FormatMapper.java

+		return false;
+	}
+
+	default <T> void writeToTarget(T value, JavaType<T> javaType, Object target, WrapperOptions options) throws IOException {


hibernate-core/src/main/java/org/hibernate/type/format/FormatMapper.java

+		throw new UnsupportedOperationException( "Unsupportd target type " + target.getClass() );
+	};
+
+	default <T> T readFromSource(JavaType<T> javaType, Object source, WrapperOptions options) throws IOException {


hibernate-core/src/main/java/org/hibernate/type/format/JsonDocumentWriter.java

+	/**
+	 * Starts a new JSON array.
+	 * @return this instance
+	 * @throws IOException an I/O error roccured while starting the object.


hibernate-core/src/main/java/org/hibernate/type/format/JsonDocumentWriter.java

+	/**
+	 * Ends a new JSON array.
+	 * @return this instance
+	 * @throws IOException an I/O error roccured while starting the object.


hibernate-core/src/main/java/org/hibernate/type/format/JsonDocumentWriter.java

+	 * @param key the element name.
+	 * @return this instance
+	 * @throws IllegalArgumentException key name does not follow JSON specification.
+	 * @throws IOException an I/O error occurred while starting the object.


hibernate-core/src/main/java/org/hibernate/type/format/JsonDocumentWriter.java

+	/**
+	 * Adds a new JSON element null value.
+	 * @return this instance
+	 * @throws IOException an I/O error roccured while starting the object.


…FormatMapper

…ngly.

…vious uploads.

removed some unchecked cast warning

beikov reviewed Jan 20, 2025

View reviewed changes

ejannett changed the title ~~Hhh 17404~~ HHH-17404 : Add support of reading/writing from/to special source/target in FormatMapper Jan 20, 2025

gavinking reviewed Feb 11, 2025

View reviewed changes

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java Outdated Show resolved Hide resolved

beikov requested changes Feb 11, 2025

View reviewed changes

ejannett marked this pull request as ready for review March 20, 2025 13:24

ejannett force-pushed the HHH-17404 branch from af7a248 to 22c6d1e Compare March 26, 2025 13:29

BidyadharM force-pushed the HHH-17404 branch 3 times, most recently from 7f6496b to c964ad8 Compare March 27, 2025 09:03

beikov reviewed Mar 28, 2025

View reviewed changes

ejannett force-pushed the HHH-17404 branch from 11df130 to b58985c Compare April 9, 2025 17:47

mbellade mentioned this pull request Apr 15, 2025

HHH-19362 JsonHelper improvements to handle more mapping types #10029

Draft

beikov requested changes Apr 16, 2025

View reviewed changes

beikov force-pushed the HHH-17404 branch from 7046f95 to ecfed98 Compare April 17, 2025 14:18

github-advanced-security bot found potential problems Apr 28, 2025

View reviewed changes

hibernate-core/src/main/java/org/hibernate/type/format/StringJsonDocumentReader.java Fixed Show resolved Hide resolved

ejannett force-pushed the HHH-17404 branch from 44f5020 to 0f6024b Compare April 30, 2025 14:01

mbellade reviewed May 6, 2025

View reviewed changes

beikov reviewed May 15, 2025

View reviewed changes

...-core/src/test/java/org/hibernate/orm/test/mapping/hhh17404/OracleOsonCompatibilityTest.java Show resolved Hide resolved

beikov added the 7.1 label May 15, 2025

jeandelavarene reviewed May 22, 2025

View reviewed changes

hibernate-core/src/main/java/org/hibernate/dialect/OracleOsonArrayJdbcType.java Show resolved Hide resolved

jeandelavarene reviewed May 22, 2025

View reviewed changes

hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java Show resolved Hide resolved

mbellade mentioned this pull request Jun 5, 2025

Oracle Timesten dialect updates #10273

Open

yrodiere mentioned this pull request Jun 5, 2025

Update corporate contributor page hibernate/hibernate.org#260

Draft

ejannett force-pushed the HHH-17404 branch from 2f8a275 to 5f6f6e5 Compare June 6, 2025 15:48

github-advanced-security bot found potential problems Jun 12, 2025

View reviewed changes

ejannett force-pushed the HHH-17404 branch from 013f71a to 625fcdf Compare June 13, 2025 17:08

ejannett and others added 2 commits June 17, 2025 16:28

HHH-17404 : Support reading/writing from/to special source/target in …

601bdc6

…FormatMapper

HHH-17404: Jakarta annotation souuport for Jackson

2cf095a

ejannett and others added 28 commits June 17, 2025 16:28

HHH-17404 add flag to disable OSON extension

32cfdfc

HHH-17404 : Since thhe UUID is stored as string , retrieve it accordi…

13f45eb

…ngly.

HHH-17404 remove use of reflection

1071b76

HHH-17404 : add schema compatibility test

c1e27c5

HHH-17404 : Removed Duration mapping to intervalDS misssed during pre…

16e751a

…vious uploads.

HHH-17404 rename oson flag in oracle dialect

8727f6e

HHH-17404 add array of embeddable support

564e136

HHH-17404 Fix compile errors

cabbed6

HHH-17404 Address dialect and aggregate support comments

a95a6e1

HHH-17404 Address issues in StringJsonDocumentReader

44048c3

HHH-17404 Cleanup JsonHelper and fix nested parsing

b6f711a

HHH-17404 Cleanup JdbcTypes and Jackson/OSON availability detection

c70daed

HHH-17404 Parameterize DDL type for tests

ebf2fd0

HHH-17404 add compatibility test

33c699c

HHH-17404 Oson compatibility test fixes

96cd77d

HHH-17404 Apply code-style to OracleOsonJdbcType and misc cleanups

e3132d0

HHH-17404 rebase with upstream

38da5fa

HHH-14707 fix code style

6ec53e2

HHH-14707 Fix xml embeddable aggregate array support

e9c0d2d

HHH-17404 code style

d8dfee5

HHH-17404 fix code scna warning about switch default case

fcfee69

HHH-17404 enhance compatibility test on type chakcing

40ebb50

HHH-17404 add comment in the what's new doc

4b0b76e

HHH-17404 add test claeanup phase

9f4a5ad

HHH-17404 rebase with upstream

520cf75

HHH-17404 add new contributor to AUTHORS list

8d56bfe

removed some unchecked cast warning

HHH-17404 fix merge regresssion about struct support

288683e

HHH-17404 fix regression on OracleDialect on timeouts

b2e7730

ejannett force-pushed the HHH-17404 branch from a9d4756 to b2e7730 Compare June 17, 2025 14:28

beikov merged commit f01bcc0 into hibernate:main Jun 17, 2025
25 checks passed

HHH-17404 : Add support of reading/writing from/to special source/target in FormatMapper #9629

HHH-17404 : Add support of reading/writing from/to special source/target in FormatMapper #9629

Uh oh!

Conversation

ejannett commented Jan 16, 2025 • edited by hibernate-github-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hibernate-github-bot bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbellade left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yrodiere commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Uh oh!

Uh oh!

ejannett commented Jan 16, 2025 •

edited by hibernate-github-bot bot

Loading

hibernate-github-bot bot commented Jan 16, 2025 •

edited

Loading

yrodiere commented Jun 5, 2025 •

edited

Loading